feat HDS 2352 enable versioned documentation #1349
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Test Results 1 files 64 suites 11m 43s ⏱️ Results for commit afa8cb0. ♻️ This comment has been updated with latest results. |
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
from
ae9fb2e to
60b149c
Compare
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
from
60b149c to
35c1192
Compare
|
Fixed Webpack chunking problems and problem of redirecting some internal links. Rebased onto 4.0.0 |
timwessman
changed the title
|
Preview found from hds-demo docs/preview_1349 Demos |
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
2 times, most recently
from
f3181eb to
4b93ca4
Compare
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
3 times, most recently
from
a8bb077 to
5a693d2
Compare
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
2 times, most recently
from
861f2fc to
ba2ebdc
Compare
|
The hero on frontpage seems broken. Missing image is ok, but otherwise. Current hds.hel.fi: Demo: |
|
The menu looks funny. Color seems odd and does our component create that much repetition? "4.0.0." so many times 
|
Yep, this is our default ActionBarItem with sub items. I try to do something |
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
from
5a39c0e to
5bbe27c
Compare
|
Fixed:
|
|
Version menu is better now: |
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
from
589442b to
c6451d0
Compare
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
from
c6451d0 to
a928814
Compare
|
Home page styles are weird on demo site url. But on local build it looks now correct to me |
timwessman
force-pushed
the
HDS-2352-enable-versioned-documentation
branch
from
6c194b7 to
afa8cb0
Compare
NikoHelle
approved these changes
Nov 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Configured Gatsby to read documentation from different git branches in addition to local files. This makes it possible for a user to select which version of documentation is viewed. Header.ActionBarItem is used to choose versions in a dropdown menu.
Related Issue
Closes HDS-2352
Motivation and Context
When users update their HDS versions, they need to compare changes. Currently, previous versions are only available deep in GitHub, and therefore, they’re difficult to find.
Open issues
This PR is kind of a poc of multi-version documentation. To improve the UX, there is a separate design ticket HDS-2387.There is some problem with webpack configuration. WebPack splits prerendered content into so-called "chunks", but building fail with the default config. If there is not much content, splitting doesn't happen, and the building succeeds. So, I made a bigger chunk size to avoid splitting. This needs more investigation if we want more than three versions.All internal link hrefs are replaced with URLs with a version prefix, but for some reason, links in the content of sub-pages of/about,/foundation, and/patternsalways link to the latest version. This has to be fixed, but I haven't found a way yet.How Has This Been Tested?
Demos:
Screenshots (if appropriate):
Add to changelog